System Information (Deprecated)

The following API's have been deprecated and will be removed from the public API in a future release. They will not be replaced.

PrizmDoc Server Monitoring and Error Reporting.

GET Service/Current/Tasks

This API has been deprecated and will be removed from the public API in a future release. It will not be replaced.

This API returns a JSON list of current tasks.

Http Method

GET

Resource URL

/PCCIS/V1/Service/Current/Tasks

Parameters

None

Request Body

Empty.

Response Body

If successful, this method returns a list of objects with the following properties:

Property Name	Value	Description
id	String	The numeric ID of this task.
name	String	Information about the PrizmDoc license. "not licensed" "licensed as ‘…’"
parameters	String	The parameters that were passed to the public API.
duration	Double	The time it took to run the task.

Example
GET http://localhost:18681/PCCIS/V1/Service/Current/Tasks
Example Response
[{"id":"1340","name":"GET Service Current Tasks", "parameters":"None","duration":0}]

GET Service/History/Tasks

This API has been deprecated and will be removed from the public API in a future release. It will not be replaced.

This API returns a JSON list of previous tasks and information on when they ran and the duration of the task. The information returned will span the last two minutes.

Http Method

GET

Resource URL

/PCCIS/V1/Service/History/Tasks

Parameters

None

Request Body

Empty.

Response Body

If successful, this method returns a list of object with the following properties:

Property Name	Value	Description
id	String	The numeric ID of this task.
name	String	The name of the task. This will match, to some extent, the public API.
parameters	String	The parameters that were passed to the public API.
startTime	String	The UTC time when the task started, formatted as a string using ISO 8601. JSON does not have a formal date type so dates are represented as ISO 8601 strings.
duration	Double	The time it took to run the task.

Example
GET http://localhost:18681/PCCIS/V1/Service/History/Tasks
Example Response
[{"id":"2731","name":"GET Service History Tasks","parameters":"None", "startTime":"2013-08-14T14:23:49.5164460Z","duration":0.0080007999999999989}, {"id":"2732","name":"GET Service History Errors","parameters":"None","startTime":"2013-08- 14T14:23:49.8044748Z","duration":0}]

GET Service/History/Errors

This API has been deprecated and will be removed from the public API in a future release. It will not be replaced.

This API returns a JSON list of HistoricalLogItem for the last 15 minute time period.

Http Method

GET

Resource URL

/PCCIS/V1/Service/History/Errors

Parameters

None

Request Body

Empty.

Response Body

If successful, this method returns a list of objects with the following properties:

Property Name	Value	Description
time	String	The UTC time when the event, formatted as a string using ISO 8601. JSON does not have a formal date type so dates are represented as ISO 8601 strings.
level	String	The NLog level of the item. This may be: "Error" "Fatal"
message	String	The message associated with the event.
exception	String	Details of the exception that was thrown to cause this item to be logged. It is possible, but unlikely that this value will be NULL.

Example
GET http://localhost:18681/PCCIS/V1/Service/History/Errors
Example Response
[{"time":"2013-08-14T14:40:57.8242665Z","level":"Error","message": "End: Unable to process request","exception":"WebException: Unable to connect to the remote server"},{"time":"2013-08- 14T14:41:11.6906530Z","level":"Error","message": "Enterprise 3 document text watcher task failed","exception": "DirectoryNotFoundException: Could not find a part of the path \u0027C:\\ProgramData\\Accusoft\\Prizm\\Cache\\ dfebd89e-6cde-43b3-a535-3a52accfe311\\25c79ba3-95dd-4907-94d1- ed3f91c8a3ec\\ol1_rr150_Intermediate.xml\u0027."}]

GET Service/History/ViewingSessions

This API has been deprecated and will be removed from the public API in a future release. It will not be replaced.

The API returns a JSON list of class HistoricalViewingSession objects for the last 30 hours.

Http Method

GET

Resource URL

/PCCIS/V1/Service/History/ViewingSessions

Parameters

None

Request Body

Empty.

Response Body

If successful, this method returns a list of objects with the following properties:

Property Name	Value	Description
startTime	String	The UTC time when the event, formatted as a string using ISO 8601. JSON does not have a formal date type so dates are represented as ISO 8601 strings.
externalId	String	External reference ID string. Helpful for log tracing.
viewingSessionId	String	The document ID.

Example
GET http://localhost:18681/PCCIS/V1/Service/History/ViewingSessions
Example Response
[{"startTime":"2013-08-14T14:13:25.6740680Z","externalId": "F7-92-5C-CE-28-BE-AD-6F-79-C3-FE-FF-87-FE-FA-B6-73-7F-F5-92", "viewingSessionId":"7045a365-9f59-45eb-a1cf-7e213b5a6223"}, {"startTime":"2013-08-14T14:13:25.6740680Z","externalId": "F7-92-5C-CE-28-BE-AD-6F-79-C3-FE-FF-87-FE-FA-B6-73-7F-F5-92", "viewingSessionId":"0f0f0854-3019-4028-a576-27977dc01855"}, {"startTime":"2013-08-14T14:24:35.3830322Z","externalId": "F7-92-5C-CE-28-BE-AD-6F-79-C3-FE-FF-87-FE-FA-B6-73-7F-F5-92", "viewingSessionId":"bb2d91c7-4cf7-477b-a726-67349ee05a92}]